<!-- HTML header for doxygen 1.8.18-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Ipopt: src/Interfaces/IpReturnCodes_inc.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  $(document).ready(function() { init_search(); });
/* @license-end */
</script>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
  extensions: ["tex2jax.js"],
  jax: ["input/TeX","output/HTML-CSS"],
});
</script>
<script type="text/javascript" async="async" src="https://cdn.jsdelivr.net/npm/mathjax@2/MathJax.js"></script>
<link href="stylesheet.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 40px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Ipopt Documentation
   &#160;<!--span id="projectnumber">3.14.17</span-->
   </div>
  </td>
   <td>        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <span id="MSearchSelect"                onmouseover="return searchBox.OnSearchSelectShow()"                onmouseout="return searchBox.OnSearchSelectHide()">&#160;</span>
          <input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
          </span>
        </div>
</td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('IpReturnCodes__inc_8h.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

<div class="header">
  <div class="summary">
<a href="#enum-members">Enumerations</a>  </div>
  <div class="headertitle"><div class="title">IpReturnCodes_inc.h File Reference</div></div>
</div><!--header-->
<div class="contents">

<p><a href="IpReturnCodes__inc_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="enum-members" name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:ab542e0b1ca364a9b7525a876ffdae7d7" id="r_ab542e0b1ca364a9b7525a876ffdae7d7"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="IpReturnCodes__inc_8h.html#ab542e0b1ca364a9b7525a876ffdae7d7">ApplicationReturnStatus</a> { <br />
&#160;&#160;<a class="el" href="IpReturnCodes__inc_8h.html#ab542e0b1ca364a9b7525a876ffdae7d7a98f85390ead47dbab52ac6d20aef904b">Solve_Succeeded</a> = 0
, <a class="el" href="IpReturnCodes__inc_8h.html#ab542e0b1ca364a9b7525a876ffdae7d7a92f8eacc090978c022fea86c54c45cc9">Solved_To_Acceptable_Level</a> = 1
, <a class="el" href="IpReturnCodes__inc_8h.html#ab542e0b1ca364a9b7525a876ffdae7d7a974f4eb9bd69b20dd3673ce5818a7e94">Infeasible_Problem_Detected</a> = 2
, <a class="el" href="IpReturnCodes__inc_8h.html#ab542e0b1ca364a9b7525a876ffdae7d7addfb3d9c0405ecdfbdb1f32254017fdf">Search_Direction_Becomes_Too_Small</a> = 3
, <br />
&#160;&#160;<a class="el" href="IpReturnCodes__inc_8h.html#ab542e0b1ca364a9b7525a876ffdae7d7aec795ebbb7b3e1541f6b97798d280ece">Diverging_Iterates</a> = 4
, <a class="el" href="IpReturnCodes__inc_8h.html#ab542e0b1ca364a9b7525a876ffdae7d7adc86c05bff28bad8f7aac1c137a3f41b">User_Requested_Stop</a> = 5
, <a class="el" href="IpReturnCodes__inc_8h.html#ab542e0b1ca364a9b7525a876ffdae7d7a0dcf6c64863a03d97a2fa58be5e707e0">Feasible_Point_Found</a> = 6
, <a class="el" href="IpReturnCodes__inc_8h.html#ab542e0b1ca364a9b7525a876ffdae7d7a0189b0cc93b81ccbada3b94a63616c13">Maximum_Iterations_Exceeded</a> = -1
, <br />
&#160;&#160;<a class="el" href="IpReturnCodes__inc_8h.html#ab542e0b1ca364a9b7525a876ffdae7d7a019adb1693a37754d6e4835fe9f84bd0">Restoration_Failed</a> = -2
, <a class="el" href="IpReturnCodes__inc_8h.html#ab542e0b1ca364a9b7525a876ffdae7d7a0794dd271a1920d3994be748c35141ac">Error_In_Step_Computation</a> = -3
, <a class="el" href="IpReturnCodes__inc_8h.html#ab542e0b1ca364a9b7525a876ffdae7d7ad84aa273f0cb8f39234dde9977367ee7">Maximum_CpuTime_Exceeded</a> = -4
, <a class="el" href="IpReturnCodes__inc_8h.html#ab542e0b1ca364a9b7525a876ffdae7d7a4fbfad0d0db07cab35a179549ed319a4">Maximum_WallTime_Exceeded</a> = -5
, <br />
&#160;&#160;<a class="el" href="IpReturnCodes__inc_8h.html#ab542e0b1ca364a9b7525a876ffdae7d7a34bdd4992f673fdba7e9af07aff3535e">Not_Enough_Degrees_Of_Freedom</a> = -10
, <a class="el" href="IpReturnCodes__inc_8h.html#ab542e0b1ca364a9b7525a876ffdae7d7ad0a0d57cad08c84c2051c98915e3233f">Invalid_Problem_Definition</a> = -11
, <a class="el" href="IpReturnCodes__inc_8h.html#ab542e0b1ca364a9b7525a876ffdae7d7a621c0a01dc6cedc7d03b0ff1ea4ac188">Invalid_Option</a> = -12
, <a class="el" href="IpReturnCodes__inc_8h.html#ab542e0b1ca364a9b7525a876ffdae7d7abb3cc51c1d4edc58677138c1ef5698d6">Invalid_Number_Detected</a> = -13
, <br />
&#160;&#160;<a class="el" href="IpReturnCodes__inc_8h.html#ab542e0b1ca364a9b7525a876ffdae7d7a77a7456dabd944cce710ce7266cf5f68">Unrecoverable_Exception</a> = -100
, <a class="el" href="IpReturnCodes__inc_8h.html#ab542e0b1ca364a9b7525a876ffdae7d7ab0be8224a4a7a5300064f331feeb22ab">NonIpopt_Exception_Thrown</a> = -101
, <a class="el" href="IpReturnCodes__inc_8h.html#ab542e0b1ca364a9b7525a876ffdae7d7a6e1029ad992d12be7b42fe2191bcf984">Insufficient_Memory</a> = -102
, <a class="el" href="IpReturnCodes__inc_8h.html#ab542e0b1ca364a9b7525a876ffdae7d7a7e80a0d4d157e4badc74e724669a5066">Internal_Error</a> = -199
<br />
 }</td></tr>
<tr class="memdesc:ab542e0b1ca364a9b7525a876ffdae7d7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return codes for the Optimize call for an application.  <a href="IpReturnCodes__inc_8h.html#ab542e0b1ca364a9b7525a876ffdae7d7">More...</a><br /></td></tr>
<tr class="separator:ab542e0b1ca364a9b7525a876ffdae7d7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5daff61568f9909c518fb61116260387" id="r_a5daff61568f9909c518fb61116260387"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="IpReturnCodes__inc_8h.html#a5daff61568f9909c518fb61116260387">AlgorithmMode</a> { <a class="el" href="IpReturnCodes__inc_8h.html#a5daff61568f9909c518fb61116260387aaab2802dbcdfe8648618b9bdcd02e3cb">RegularMode</a> = 0
, <a class="el" href="IpReturnCodes__inc_8h.html#a5daff61568f9909c518fb61116260387accee74140d41706398be37bc4b04a703">RestorationPhaseMode</a> = 1
 }</td></tr>
<tr class="memdesc:a5daff61568f9909c518fb61116260387"><td class="mdescLeft">&#160;</td><td class="mdescRight">enum to indicate the mode in which the algorithm is  <a href="IpReturnCodes__inc_8h.html#a5daff61568f9909c518fb61116260387">More...</a><br /></td></tr>
<tr class="separator:a5daff61568f9909c518fb61116260387"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="ab542e0b1ca364a9b7525a876ffdae7d7" name="ab542e0b1ca364a9b7525a876ffdae7d7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab542e0b1ca364a9b7525a876ffdae7d7">&#9670;&#160;</a></span>ApplicationReturnStatus</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="IpReturnCodes__inc_8h.html#ab542e0b1ca364a9b7525a876ffdae7d7">ApplicationReturnStatus</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Return codes for the Optimize call for an application. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ab542e0b1ca364a9b7525a876ffdae7d7a98f85390ead47dbab52ac6d20aef904b" name="ab542e0b1ca364a9b7525a876ffdae7d7a98f85390ead47dbab52ac6d20aef904b"></a>Solve_Succeeded&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="ab542e0b1ca364a9b7525a876ffdae7d7a92f8eacc090978c022fea86c54c45cc9" name="ab542e0b1ca364a9b7525a876ffdae7d7a92f8eacc090978c022fea86c54c45cc9"></a>Solved_To_Acceptable_Level&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="ab542e0b1ca364a9b7525a876ffdae7d7a974f4eb9bd69b20dd3673ce5818a7e94" name="ab542e0b1ca364a9b7525a876ffdae7d7a974f4eb9bd69b20dd3673ce5818a7e94"></a>Infeasible_Problem_Detected&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="ab542e0b1ca364a9b7525a876ffdae7d7addfb3d9c0405ecdfbdb1f32254017fdf" name="ab542e0b1ca364a9b7525a876ffdae7d7addfb3d9c0405ecdfbdb1f32254017fdf"></a>Search_Direction_Becomes_Too_Small&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="ab542e0b1ca364a9b7525a876ffdae7d7aec795ebbb7b3e1541f6b97798d280ece" name="ab542e0b1ca364a9b7525a876ffdae7d7aec795ebbb7b3e1541f6b97798d280ece"></a>Diverging_Iterates&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="ab542e0b1ca364a9b7525a876ffdae7d7adc86c05bff28bad8f7aac1c137a3f41b" name="ab542e0b1ca364a9b7525a876ffdae7d7adc86c05bff28bad8f7aac1c137a3f41b"></a>User_Requested_Stop&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="ab542e0b1ca364a9b7525a876ffdae7d7a0dcf6c64863a03d97a2fa58be5e707e0" name="ab542e0b1ca364a9b7525a876ffdae7d7a0dcf6c64863a03d97a2fa58be5e707e0"></a>Feasible_Point_Found&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="ab542e0b1ca364a9b7525a876ffdae7d7a0189b0cc93b81ccbada3b94a63616c13" name="ab542e0b1ca364a9b7525a876ffdae7d7a0189b0cc93b81ccbada3b94a63616c13"></a>Maximum_Iterations_Exceeded&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="ab542e0b1ca364a9b7525a876ffdae7d7a019adb1693a37754d6e4835fe9f84bd0" name="ab542e0b1ca364a9b7525a876ffdae7d7a019adb1693a37754d6e4835fe9f84bd0"></a>Restoration_Failed&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="ab542e0b1ca364a9b7525a876ffdae7d7a0794dd271a1920d3994be748c35141ac" name="ab542e0b1ca364a9b7525a876ffdae7d7a0794dd271a1920d3994be748c35141ac"></a>Error_In_Step_Computation&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="ab542e0b1ca364a9b7525a876ffdae7d7ad84aa273f0cb8f39234dde9977367ee7" name="ab542e0b1ca364a9b7525a876ffdae7d7ad84aa273f0cb8f39234dde9977367ee7"></a>Maximum_CpuTime_Exceeded&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="ab542e0b1ca364a9b7525a876ffdae7d7a4fbfad0d0db07cab35a179549ed319a4" name="ab542e0b1ca364a9b7525a876ffdae7d7a4fbfad0d0db07cab35a179549ed319a4"></a>Maximum_WallTime_Exceeded&#160;</td><td class="fielddoc"><dl class="section since"><dt>Since</dt><dd>3.14.0 </dd></dl>
</td></tr>
<tr><td class="fieldname"><a id="ab542e0b1ca364a9b7525a876ffdae7d7a34bdd4992f673fdba7e9af07aff3535e" name="ab542e0b1ca364a9b7525a876ffdae7d7a34bdd4992f673fdba7e9af07aff3535e"></a>Not_Enough_Degrees_Of_Freedom&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="ab542e0b1ca364a9b7525a876ffdae7d7ad0a0d57cad08c84c2051c98915e3233f" name="ab542e0b1ca364a9b7525a876ffdae7d7ad0a0d57cad08c84c2051c98915e3233f"></a>Invalid_Problem_Definition&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="ab542e0b1ca364a9b7525a876ffdae7d7a621c0a01dc6cedc7d03b0ff1ea4ac188" name="ab542e0b1ca364a9b7525a876ffdae7d7a621c0a01dc6cedc7d03b0ff1ea4ac188"></a>Invalid_Option&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="ab542e0b1ca364a9b7525a876ffdae7d7abb3cc51c1d4edc58677138c1ef5698d6" name="ab542e0b1ca364a9b7525a876ffdae7d7abb3cc51c1d4edc58677138c1ef5698d6"></a>Invalid_Number_Detected&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="ab542e0b1ca364a9b7525a876ffdae7d7a77a7456dabd944cce710ce7266cf5f68" name="ab542e0b1ca364a9b7525a876ffdae7d7a77a7456dabd944cce710ce7266cf5f68"></a>Unrecoverable_Exception&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="ab542e0b1ca364a9b7525a876ffdae7d7ab0be8224a4a7a5300064f331feeb22ab" name="ab542e0b1ca364a9b7525a876ffdae7d7ab0be8224a4a7a5300064f331feeb22ab"></a>NonIpopt_Exception_Thrown&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="ab542e0b1ca364a9b7525a876ffdae7d7a6e1029ad992d12be7b42fe2191bcf984" name="ab542e0b1ca364a9b7525a876ffdae7d7a6e1029ad992d12be7b42fe2191bcf984"></a>Insufficient_Memory&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="ab542e0b1ca364a9b7525a876ffdae7d7a7e80a0d4d157e4badc74e724669a5066" name="ab542e0b1ca364a9b7525a876ffdae7d7a7e80a0d4d157e4badc74e724669a5066"></a>Internal_Error&#160;</td><td class="fielddoc"></td></tr>
</table>

<p class="definition">Definition at line <a class="el" href="IpReturnCodes__inc_8h_source.html#l00013">13</a> of file <a class="el" href="IpReturnCodes__inc_8h_source.html">IpReturnCodes_inc.h</a>.</p>

</div>
</div>
<a id="a5daff61568f9909c518fb61116260387" name="a5daff61568f9909c518fb61116260387"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5daff61568f9909c518fb61116260387">&#9670;&#160;</a></span>AlgorithmMode</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="IpReturnCodes__inc_8h.html#a5daff61568f9909c518fb61116260387">AlgorithmMode</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>enum to indicate the mode in which the algorithm is </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a5daff61568f9909c518fb61116260387aaab2802dbcdfe8648618b9bdcd02e3cb" name="a5daff61568f9909c518fb61116260387aaab2802dbcdfe8648618b9bdcd02e3cb"></a>RegularMode&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a5daff61568f9909c518fb61116260387accee74140d41706398be37bc4b04a703" name="a5daff61568f9909c518fb61116260387accee74140d41706398be37bc4b04a703"></a>RestorationPhaseMode&#160;</td><td class="fielddoc"></td></tr>
</table>

<p class="definition">Definition at line <a class="el" href="IpReturnCodes__inc_8h_source.html#l00041">41</a> of file <a class="el" href="IpReturnCodes__inc_8h_source.html">IpReturnCodes_inc.h</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
</body>
</html>
